/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra;

import javax.xml.soap.SOAPMessage;

import cgl.narada.wsinfra.exception.MessageFlowException;

/** This interface is to be used to facilitate plugging-in of communications
    and application flows into the processor. It is possible that there
    will be multiple implementations of this depending on the hosting 
    environment such as Axis, XSoap, Pure TCP etc.

    
    @author Shrideep Pallickara
    $Date: 2005/07/29 22:41:29 $
    $Revision: 1.4 $
*/


public interface WsMessageFlow {

  public static final int FROM_APPLICATION = 20;
  public static final int FROM_NETWORK = 21;

  /** Prepare to send message over the network. The message has been processed
      by a WsProcessor and is an outgoing message. In some implementations
      of the WsMessageFlow the sendTo element can be used an optimization 
      feature so that the need to parse the SOAP message again is obviated. An
      exemplar of such a scenario is where there is no need to parse for the
      [wsa:To] element; the address contained in this element is utlimately
      a String.  */
  public void 
  enrouteToNetwork(SOAPMessage soapMessage) 
    throws MessageFlowException;
  
  
  /** Prepare to forward message over to the application. This message has 
      been processed by the WsProcessor. */
  public void 
  enrouteToApplication(SOAPMessage soapMessage) throws MessageFlowException;
  
}
